楽天ペイ インタフェース
概要
リンクタイプ Plus決済では、決済手段として楽天ペイを利用することが可能です。楽天ペイを利用するには、実行パラメータセットに楽天ペイに必要なパラメータを渡す必要があります。
リンクタイプ Plus決済で楽天ペイが完了すると、遷移先URLに楽天ペイの結果パラメータが返却されます。
遷移先URLは設定により異なるパラメータを参照します。
詳細は「決済画面からの加盟店様サイトへの遷移」をご覧ください。
入出力パラメータ仕様
実行パラメータ仕様
楽天ペイ固有の実行パラメータは以下の通りです。
| json key | 詳細 | 指定可能箇所 | システムデフォルト設定 | ||
|---|---|---|---|---|---|
| リンクタイプPlus決済URL | 加盟店デフォルト設定 | ||||
| rakutenid |
楽天ペイ固有実行パラメータ楽天ペイの実行パラメータセットです。 |
〇 | - | ||
| JobCd | 必須
処理区分以下のいずれかを設定します。AUTH:仮売上 CAPTURE:即時売上 |
〇 | 〇 | AUTH | |
| ItemId | 必須半角英数100桁
商品ID取引情報として表示される商品IDを設定します。 |
〇 | - | (null) | |
| ItemSubId | 半角英数77桁
商品サブID取引情報として表示される商品サブIDを設定します。※加盟店様独自のポイントシステムがある加盟店様の場合必須となります。 |
〇 | - | (null) | |
| ItemName | 必須全半角255桁
商品名取引情報として表示される商品名を設定します。※UTF-8換算で255バイトが最大です。 |
〇 | - | (null) | |
結果パラメータ仕様
楽天ペイを選択した場合に、加盟店様に返却する楽天ペイ固有の結果パラメータは以下の通りです。
| rakutenid |
楽天ペイ固有部楽天ペイ固有の結果パラメータセットです。 |
|
|---|---|---|
| RakutenOrderId | 半角数字30桁
注文番号楽天ペイの注文番号が設定されます。 |
|
| Status |
取引状態取引の状態を示す以下の値が設定されます。REQAUTH:仮売上受付（仮売上要求が成功した状態） REQSALES:実売上受付（売上確定要求が成功した状態） REQCAPTURE:即時売上受付（即時売上要求が成功した状態） AUTH:仮売上（決済が正常に完了し、ご利用枠を確保した状態） SALES:売上確定 CAPTURE:売上確定 REQCANCEL:キャンセル受付（キャンセル要求が成功した状態） CANCELキャンセル確定 REQCHANGE:金額変更受付（金額変更要求が成功した状態） PAYFAIL:決済失敗（決済がエラーとなり支払いに失敗してしまった状態お客様による支払い中断や、システムトラブル等の何らかの原因でお支払いに失敗してしまった状態） EXPIRED:期限切れ（お客様がお支払いされることなく、有効期限が切れてしまった状態） |
|
| TranDate | 半角数字14桁
決済日時決済を行った日時が設定されます。（yyyyMMddHHmmss形式） |
|
| OrderDate | 半角数字14桁
注文日時注文を行った日時が設定されます。（yyyyMMddHHmmss形式） |
|
| CompletionDate | 半角数字8桁
完了日決済完了日が設定されます。（yyyyMMdd形式） |
|
| RakutenidCouponFee | 半角数字8桁
クーポン金額決済時に使用されたクーポンの金額が設定されます。クーポンが使用されていない取引の場合、0になります。 |
|
| RakutenidSubscriptionId |
サブスクリプションID設定されません。 |
|
| RakutenidSettlementSubscriptionId |
決済用サブスクリプションID設定されません。 |
|